home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Special 11 / Amiga Plus 11: Amiga Future.iso / c / textract.doc < prev    next >
Text File  |  1996-02-01  |  8KB  |  219 lines
  1.  
  2.  
  3.  
  4.                  _____.  __________.  __________. __ _____
  5.                 /     |_/   ___    |_/   ___    | \//    /
  6.                 |     ||     \/    ||     \/    |  /    /
  7.                 |     ||     /     ||     /     | /    /__
  8.                 |____/~|__________/~|__________/~ \___/ \/
  9.                 ------------------------------------------
  10.                       1oo Percent CNet Anscii Design
  11.  
  12.                            Textract v1.o by dRm!
  13.  
  14.  
  15.  
  16.  
  17.  
  18.     - -- 1. Short Description ]----.
  19. - -- --- --------------------------'
  20.  
  21.     Program: Textract v1.o
  22.    Function: Extracts/adds File_ID.diz from/to Textfiles
  23.              Decent replacement for TxtExtract, no trashing of
  24.              Textfiles when adding Diz!
  25.      Author: Dreamer/Abyss/1oo%
  26. Releasedate: Fri 02-Feb-1996 00:00
  27.  
  28.  
  29.  
  30.  
  31.     - -- 2. Copyright and Disclaimer ]----.
  32. - -- --- ---------------------------------'
  33.  
  34. This  package is freely distributable.  That means:  you are allowed to re-
  35. distribute this package, as long as you respect these regulations:
  36.  
  37. a. Everything  in  this package is regarded as freeware, which means
  38.    that  the  author  holds  full copyright, but its free to use for
  39.    you.  But please: 'free' does NOT include any support in any way,
  40.    though I will try to help, provided I got enough spare time...
  41.  
  42. b. This package may be freely distributed via BBSs, InterNet/UseNet,
  43.    software  libraries  such  as  Fred Fish's and Aminet CD-ROM, and
  44.    other  similar  electronic  channels.  Only  the complete package
  45.    without modifications may be redistributed.
  46.  
  47. c. It  IS allowed to include the contents of this package to related
  48.    software  like  BBS-packages  (even  if  they  are commercial) or
  49.    "Dizzers",  provided  that  the  program comes together with this
  50.    documentation  without  any modifications, and sending me a short
  51.    note about it (see end of this doc for e-mail addresses).
  52.  
  53. By  using  this  product, you accept that the author can NOT be held liable
  54. for any damage or loss that might occur through its use or the inability to
  55. use it.  The developer(s) of the software can NOT be held responsible.  Use
  56. entirely at your own risk.
  57.  
  58. (Dunno why I have to write such a monster disclaimer... =)
  59.  
  60.  
  61.  
  62.  
  63.     - -- 3. Introduction ]----.
  64. - -- --- ---------------------'
  65.  
  66. I  suppose  you  know which purpose this program fulfils.  I rather want to
  67. tell  you  something  about  the  motivation of writing a replacement for a
  68. program  which  already  exists  and  is used for quite a long time, namely
  69. TXTextract  by  Spy/Mystic/XDesign.   This program does its job quite well,
  70. until the following occurs:  you want to add a changed (or new) File_ID.diz
  71. to  a textfile  which already contains a description.  In most of the cases
  72. the  file  gets  totally trashed.  And as it seems the author of TXTextract
  73. will  never fix that bug, I wrote this small replacement (in C code), which
  74. is 1oo% compatible regarding the supported functions ('a', 'e', and 'f').
  75.  
  76.  
  77.  
  78.  
  79.     - -- 4.1. Installation ]----.
  80. - -- --- -----------------------'
  81.  
  82. Just  replace your old TxtExtract (sometimes called TxtDescript, too), with
  83. Textract (by renaming or changing your configurations.  I suppose first. =)
  84.  
  85.  
  86.  
  87.  
  88.     - -- 4.2. Usage ]----.
  89. - -- --- ----------------'
  90.  
  91. USAGE : Textract [options] e <diztination> <source>
  92.         for extracting a file-description
  93.  
  94.         Textract [options] f <source> <destination> <description>
  95.         to add a new filedescription from a file
  96.  
  97.         Textract [options] a <description> <source/destination>
  98.         to add a new filedescription from a file
  99.  
  100. *NEW*   Textract [options] d <source> <destination>
  101.         to delete a filedescription in a file
  102.  
  103. *NEW*   Textract [options] k <source/destination>
  104.         to kill a filedescription in a file
  105.  
  106.  
  107. Remark: The  command  'p'  for writing a description directly from stdin is
  108.         not  supported,  as  we think there is no need for it anymore (btw:
  109.         the textfile gets trashed by TxtExtract anyway, if a diz is already
  110.         present).  If  you  are in desperate need of it, mail me, and we'll
  111.         see...
  112.  
  113. Options: -xxx = With  this  option  it  is possible to set the buffer in KB
  114.                 used while extracting or adding. Valid values range from 16
  115.                 to  1024 (1 MB Buffer). The value will be rounded up to the
  116.                 next  multiply  of  16. Default value is 128KB. I think you
  117.                 only  have  to  set this to a lower value if you are really
  118.                 low on memory.
  119.  
  120.                 Additionally,  if  the length of the file is lower than the
  121.                 buffer, only the needed buffers will be allocated.
  122.                 (Example: Buffer at 128K (default), Filelength 48K,
  123.                           => allocated buffer: 64K)
  124.  
  125.           -c   = Strips <CR>'s from descriptions, useful for PC-Textfiles.
  126.  
  127.  
  128.  
  129.  
  130.     - -- 4.3 Known Bugs and strange behavior ]----.
  131. - -- --- -----------------------------------------'
  132.  
  133. There are no known bugs at the moment.
  134.  
  135. Yet  using  the f, a, d or k command with a TxtExtract-trashed textfile can
  136. cause  serious  trouble (or textfiles with a stand-alone @BEGIN_FILE_ID.DIZ
  137. somewhere in the textfile in general).
  138.  
  139. The  following  happens:   if  a textfile gets corrupted by TxtExtract, not
  140. only  parts  of  the  file  vanish  in  NIL:,  but  it  also leaves a stray
  141. @BEGIN_FILE_ID.DIZ  somewhere  in  the  file.   If  you  now  try  to add a
  142. File_ID.diz  to  such  a  file,  the DeleteDiz-Subroutine will be called to
  143. remove  the OLD File_ID.diz first.  This searches the text for the @BEGIN..
  144. marker,  then  deleting  everything until the @END..  marker is found.  Now
  145. imagine  what  happens  to  a  textfile  with  a @BEGIN..  somewhere and NO
  146. correspondig  @END.   Right,  everything  from  the  @BEGIN..   on  will be
  147. deleted.  Just test it with a copy of this text:  Try to delete the FileID.
  148. You  will  see that the text suddenly ends in the middle of this paragraph.
  149. (Most likly it will end with "textfiles with a stand-alone "[EOF] =)
  150.  
  151. Again:   This  behavior  looks strange, but it is NO bug!  Blame TxtExtract
  152. instead.  =)
  153.  
  154. Btw:   Strange  crashes  occured with the statram.device (e.g.  sd0:).  Use
  155. RAM:  instead.
  156.  
  157.  
  158.  
  159.  
  160.     - -- 5. History ]----.
  161. - -- --- ----------------'
  162.  
  163. V1.o  - Initial release.
  164.  
  165.  
  166.  
  167.  
  168.     - -- 6. Escpecially reserved space... ]----.
  169. - -- --- --------------------------------------'
  170.  
  171. ...   for  MXLPRX,  who  found most of the bugs during development, and who
  172. want to especially appear in this doc.  So here u are!  =)
  173.  
  174. ...   and  for  Neurodancer,  who  didn't find any bugs, but gave some good
  175. suggestions  (The  -c  option  was  his  idea).  And for proof-reading this
  176. doc, of course!
  177.  
  178. Thanx mates!
  179.  
  180.  
  181.  
  182.  
  183.     - -- 7. How to get in touch ]----.
  184. - -- --- ----------------------------'
  185.  
  186.          For suggestions, bugreports and smalltalk drop a mail to
  187.  
  188.                      mics@rummelplatz.uni-mannheim.de
  189.                             Fido: 2:2480/520.3
  190.                             Warp: 137:15/301.1
  191.                             Coco:   99:107/1.3
  192.  
  193.                  http://rummelplatz.uni-mannheim.de/~mics
  194.  
  195.  
  196.  
  197.                     For anything regarding 1oo%, mail:
  198.  
  199.                         neurodancer@another.gun.de
  200.                              Fido: 2:2480/520
  201.                              Warp: 137:15/301
  202.                              Coco:   99:107/1
  203.  
  204.  
  205.  
  206.     - -- 8. 1oo% Member/Distribution Sites ]----.
  207. - -- --- ---------------------------------------'
  208.  
  209.     GER: The Ambush, +49-8621-64260, 24h, USR 33.6
  210.     GER: Digital Dungeons, +49-6192-910718, 24h, USR 33.6
  211.     GER: Cafe del Mar, +49-6220-private, 24h, USR 33.6
  212.     GER: Confusion, +49-341-private
  213.     USA: Ill Communication, +1-310-329-2283 & 2591, 24h, USR 33.6
  214.  
  215.     WWW: http://rummelplatz.uni-mannheim.de/~mics/100.html
  216.  
  217.  
  218.  
  219.